/**
 * Copyright (c) 2009 Teoti Graphix, LLC See:
 *     http://tkarchitecture.teotigraphix.org
 * 
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 * 
 * @author Michael Schmalle mschmalle@teotigraphix.com
 */
package org.example.ui.model
{

import org.example.ui.component.IButton;
import org.teotigraphix.dx.interfaces.ISkinStateAware;

/**
 * The contract a core button behavior makes with a core button model
 * to maintain behavioral state.
 * 
 * @copyright Teoti Graphix, LLC
 * @author Michael Schmalle
 * @date 07-15-09
 */
public interface IButtonModel 
	   extends IButton, ISkinStateAware
{
	//--------------------------------------------------------------------------
	//
	//  Properties
	//
	//--------------------------------------------------------------------------
	
	//----------------------------------
	//  hoveredOver
	//----------------------------------
	
	/**
	 * Whether the button has handled a ROLL_OVER or MOUSE_UP over.
	 */
	function get hoveredOver():Boolean;

	/**
	 * @private
	 */
	function set hoveredOver(value:Boolean):void;
	
	//----------------------------------
	//  keyboardPressed
	//----------------------------------
	
	/**
	 * Whether the keyboard has been pressed while the button has focus.
	 */
	function get keyboardPressed():Boolean;

	/**
	 * @private
	 */
	function set keyboardPressed(value:Boolean):void;
	
	//----------------------------------
	//  mouseCaptured
	//----------------------------------
	
	/**
	 * Whether the button has captured the mouse by a MOUSE_DOWN event.
	 */
	function get mouseCaptured():Boolean;
	
	/**
	 * @private
	 */
	function set mouseCaptured(value:Boolean):void;
	
	//--------------------------------------------------------------------------
	//
	//  Methods
	//
	//--------------------------------------------------------------------------
	
	/**
	 * Whether the button is in a down state or not.
	 */
	function isDown():Boolean;
}
}